#ifndef _tenacitas__log__README_h_
#define _tenacitas__log__README_h_

/** @mainpage Tutorial

  @section simple_logger Using the tenacitas::log::simple_logger

There is a logger class defined, called tenacitas::log::simple_logger, which: 
- writes log messages in a text file
- creates a log file for each thread in the program
- each line has the format:

    <tt>
    log-level-name|nanoseconds-time-stamp|file-name|function-name|line-number|log-msg<i>[</i>|log-msg<i>]*</i>
    </tt>

    For example:
    <tt>
    debug|1371041696390809660|hasher.cpp|md5|345|hello world!|x = 32
    </tt>

- a new text log file is created every time the log file reaches a user defined
size

- log text files's names have the format:
        - while the thread that is logging messages does not end:
        <tt><i>pgm-name</i>_<i>pid</i>_<i>thread-id</i>_<i>file-index</i>.log</tt>

        - after the thread that is logging messages ended:
        <tt><i>pgm-name</i>_<i>pid</i>_<i>thread-id</i>_<i>file-index</i>.log.END</tt>

        For example:

        <tt>
        /var/tmp/hash_3216_7854_0.log

        /var/tmp/hash_3216_7854_1.log.END
        </tt>

@subsection simple_logger_example Examples
So, if @p simple_logger is good enough for you, @p tenacitas::log::simple_logger
is defined at <tt>cpp/code/inc/tenacitas_log/simple_logger.h</tt>.

To see how to use tenacitas::log::simple_logger, please study some examples at
<tt>cpp/code/tst/tenacitas_log/test1.cpp</tt>. 

It is also important to read the documentation for
tenacitas::log::config_simple_logger. 

@section user_logger Defining your own logger

But, if tenacitas::log::simple_logger does not suit your needs, please, read
the documentation of @p tenacitas::log::logger class, at
<tt>cpp/code/inc/tenacitas_log/logger.h</tt> file.
If you want to log messages in a file, please also read  @p tenacitas::log::file
at <tt>cpp/code/inc/tenacitas_log/file.h</tt> file.





*/

#endif // README_H
